chore(docs): include the environment variables section in the utilities documentation #2925
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarifies Tracer's documentation page by including its related environment variables.
Clarifies Logger's documentation page by including its related environment variables.
Clarifies Metrics' documentation page by including its related environment variables.
Clarifies middleware factory's documentation page by including its related environment variables.
Clarifies parameters utility's documentation page by including its related environment variables.
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/M
This was referenced Aug 4, 2023
|
Thanks for sending this PR @barreeeiroo!! Hei @heitorlessa! Since I don't have the context here, I'd like your review or we can sync tomorrow and I can review. |
leandrodamascena
requested changes
Aug 8, 2023
There was a problem hiding this comment.
Hello @barreeeiroo! I made a couple of small comments and after that I think we're ready to merge!
Thank you very much.
It should be the last one under Getting Started and right before Advanced.
As basic configuration mentions a few environment variables, it may be useful to provide a link to all the other available ones.
1 task
|
Kudos, SonarCloud Quality Gate passed!
|
leandrodamascena
changed the title
leandrodamascena
approved these changes
Aug 9, 2023
There was a problem hiding this comment.
Fantastic work @barreeeiroo! This will make it easier for our customers to find environment variables that can be used in each utility.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: #2923
Supersedes: #2922
Summary
Clarifies some documentation pages by including their related environment variables. They were only included on the main page, though it may be useful to also mention them on their corresponding page.
Changes
For each page, a new Environment variables section was created under Getting started right before Advanced. This section contains a table listing all environment variables affecting that page. It also mentions the preference order (parameter overrides environment variable).
User experience
When navigating through documentation, developers will now find the environment variables for each core/utility on its page. It is useful as it allows us to quickly understand the behaviour of these environment variables by Ctrl+F'ing them.
This comes from personal experience, as I found out about Tracer's environment variables by checking the parameters of Tracer decorators' source code. But when going to Tracer's documentation page, I couldn't find these environment variables, until I realized they were only in the main page.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
No.
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.